Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAD-4437 Include UTxO HD installation/usage instructions in READMEs #4079

Conversation

jorisdral
Copy link

@jorisdral jorisdral commented Jun 23, 2022

This PR aims to update documentation to account for the UTxO HD feature. The LMDB backend in particular requires some additional instructions to set up. The updated documentation should highlight changes in cardano-node usage/configuration, and changes in cardano-node installation instructions.

The following documentation files have been updated:

/README.rst
/doc/getting-started/building-the-node-on-windows.md
/doc/getting-started/building-the-node-using-nix.md
/doc/getting-started/install.md
/doc/getting-started/understanding-config-files.md

Somewhat related is this PR in cardano-node-tests, which updates scripts that are used to verify that the build instructions are sufficient to build the node from scratch on Linux distributions.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Member

@dnadales dnadales left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Joris 🙌

Can we limit the text width to 80 characters?

Copy link
Contributor

@jasagredo jasagredo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with some comments

doc/getting-started/building-the-node-on-windows.md Outdated Show resolved Hide resolved
doc/getting-started/building-the-node-on-windows.md Outdated Show resolved Hide resolved
* Added installation/usage instructions for UTxO HD to top-level README,
installation instructions, and node config file instructions.
* More documentation for `defaultLMDBLimits`.
* Other change: Parsing behaviour for LMDB mapsize should now allow
parsing more types of units. The previous parsing behaviour would only
parse 1024-based units such Mebibytes, Gibibytes, etc. Now, we can also
provide 1000-based units, for example.
* Fixed Redhat/Fedora/CentOS installation instructions, which was
missing an instruction to install OpenSSL libraries, amongst others.
* Crudely updated the Windows installation instructions; requires a
Windows machine to update the instructions.
@jasagredo and @layogeshsajanikar have provided update instructions for
Windows, which are based on the build steps on their Windows
machines/VMs.
@jorisdral jorisdral force-pushed the jdral/CAD-4437-utxo-hd-readme-instructions branch from aa56d38 to db9461f Compare July 6, 2022 14:32
@jorisdral jorisdral merged commit 93fbacc into consensus/feature/utxo-hd Jul 6, 2022
@iohk-bors iohk-bors bot deleted the jdral/CAD-4437-utxo-hd-readme-instructions branch July 6, 2022 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants